GET api/SIMS/GetClientDetails?clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}&companyKey={companyKey}
Gets the client details for the specified client(s). If no client code(s) are specified, the details of all clients are returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientCodes |
A list of client code(s) (Optional) |
Collection of string |
Required |
companyKey |
The company name if the service is connected to multiple SIMS companies (Optional) |
string |
Default value is |
Body Parameters
N/A
Response Information
Resource Description
The client(s) details
Collection of ApiClientName | Description | Type | Additional information |
---|---|---|---|
Code | string |
N/A |
|
Name | string |
N/A |
|
Currency | string |
N/A |
|
Balance | decimal number |
N/A |
|
Discount | decimal number |
N/A |
|
Credit | integer |
N/A |
|
CreditDays | integer |
N/A |
|
Group | string |
N/A |
|
IdNumber | string |
N/A |
|
string |
N/A |
||
Phone | string |
N/A |
|
MobileNo | string |
N/A |
|
ContactTitle | string |
N/A |
|
ContactName | string |
N/A |
|
ContSurname | string |
N/A |
|
Address1 | string |
N/A |
|
Address2 | string |
N/A |
|
Address3 | string |
N/A |
|
Address4 | string |
N/A |
|
Address5 | string |
N/A |
|
OnHold | boolean |
N/A |
|
Fax | string |
N/A |
|
Telex | string |
N/A |
|
VatReg | string |
N/A |
|
EuCountry | string |
N/A |
|
TurnYear | decimal number |
N/A |
|
TurnLsYear | decimal number |
N/A |
|
SellingP | decimal number |
N/A |
Response Formats
application/json, text/json
Sample:
[ { "Code": "sample string 1", "Name": "sample string 2", "Currency": "sample string 3", "Balance": 4.0, "Discount": 5.0, "Credit": 6, "CreditDays": 7, "Group": "sample string 8", "IdNumber": "sample string 9", "Email": "sample string 10", "Phone": "sample string 11", "MobileNo": "sample string 12", "ContactTitle": "sample string 13", "ContactName": "sample string 14", "ContSurname": "sample string 15", "Address1": "sample string 16", "Address2": "sample string 17", "Address3": "sample string 18", "Address4": "sample string 19", "Address5": "sample string 20", "OnHold": true, "Fax": "sample string 22", "Telex": "sample string 23", "VatReg": "sample string 24", "EuCountry": "sample string 25", "TurnYear": 26.0, "TurnLsYear": 27.0, "SellingP": 28.0 }, { "Code": "sample string 1", "Name": "sample string 2", "Currency": "sample string 3", "Balance": 4.0, "Discount": 5.0, "Credit": 6, "CreditDays": 7, "Group": "sample string 8", "IdNumber": "sample string 9", "Email": "sample string 10", "Phone": "sample string 11", "MobileNo": "sample string 12", "ContactTitle": "sample string 13", "ContactName": "sample string 14", "ContSurname": "sample string 15", "Address1": "sample string 16", "Address2": "sample string 17", "Address3": "sample string 18", "Address4": "sample string 19", "Address5": "sample string 20", "OnHold": true, "Fax": "sample string 22", "Telex": "sample string 23", "VatReg": "sample string 24", "EuCountry": "sample string 25", "TurnYear": 26.0, "TurnLsYear": 27.0, "SellingP": 28.0 } ]